<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>ESP8266_RTOS_SDK: Rate Control APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ESP8266_RTOS_SDK
   &#160;<span id="projectnumber">v1.4.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Rate Control APIs<div class="ingroups"><a class="el" href="group__WiFi__APIs.html">WiFi Related APIs</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>WiFi Rate Control APIs.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gab8894904f7cbe1f3719c5dccb75e5c35"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab8894904f7cbe1f3719c5dccb75e5c35"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>FIXED_RATE_MASK_NONE</b>&#160;&#160;&#160;0x00</td></tr>
<tr class="separator:gab8894904f7cbe1f3719c5dccb75e5c35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga53b79ca6fd15052736b492b803ae571b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga53b79ca6fd15052736b492b803ae571b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>FIXED_RATE_MASK_STA</b>&#160;&#160;&#160;0x01</td></tr>
<tr class="separator:ga53b79ca6fd15052736b492b803ae571b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga563d5b30521d8ba08130327962865f75"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga563d5b30521d8ba08130327962865f75"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>FIXED_RATE_MASK_AP</b>&#160;&#160;&#160;0x02</td></tr>
<tr class="separator:ga563d5b30521d8ba08130327962865f75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f03692433fb2fbfb0f1dd9b98351155"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3f03692433fb2fbfb0f1dd9b98351155"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>FIXED_RATE_MASK_ALL</b>&#160;&#160;&#160;0x03</td></tr>
<tr class="separator:ga3f03692433fb2fbfb0f1dd9b98351155"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga359bf2e253e1112eedfb12dddf0f0be1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga359bf2e253e1112eedfb12dddf0f0be1"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>RC_LIMIT_11B</b>&#160;&#160;&#160;0</td></tr>
<tr class="separator:ga359bf2e253e1112eedfb12dddf0f0be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9e154b536fb28dcd8d1ef5227dcb9e27"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9e154b536fb28dcd8d1ef5227dcb9e27"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>RC_LIMIT_11G</b>&#160;&#160;&#160;1</td></tr>
<tr class="separator:ga9e154b536fb28dcd8d1ef5227dcb9e27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga968a7f8d84c80912bf3856ae290b44fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga968a7f8d84c80912bf3856ae290b44fd"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>RC_LIMIT_11N</b>&#160;&#160;&#160;2</td></tr>
<tr class="separator:ga968a7f8d84c80912bf3856ae290b44fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafdec51a262f5c39b7a2dd2587dbf1672"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafdec51a262f5c39b7a2dd2587dbf1672"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>RC_LIMIT_P2P_11G</b>&#160;&#160;&#160;3</td></tr>
<tr class="separator:gafdec51a262f5c39b7a2dd2587dbf1672"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf099d88294782dd5849df5e9d3c72821"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf099d88294782dd5849df5e9d3c72821"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>RC_LIMIT_P2P_11N</b>&#160;&#160;&#160;4</td></tr>
<tr class="separator:gaf099d88294782dd5849df5e9d3c72821"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga235926d5bd2ef6b4cf2052addebe3828"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga235926d5bd2ef6b4cf2052addebe3828"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>RC_LIMIT_NUM</b>&#160;&#160;&#160;5</td></tr>
<tr class="separator:ga235926d5bd2ef6b4cf2052addebe3828"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga884176f7441a84bdfdf01b5cf2172356"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga884176f7441a84bdfdf01b5cf2172356"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>LIMIT_RATE_MASK_NONE</b>&#160;&#160;&#160;0x00</td></tr>
<tr class="separator:ga884176f7441a84bdfdf01b5cf2172356"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac29195c8af01d16d70c31f0bd24855e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac29195c8af01d16d70c31f0bd24855e7"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>LIMIT_RATE_MASK_STA</b>&#160;&#160;&#160;0x01</td></tr>
<tr class="separator:gac29195c8af01d16d70c31f0bd24855e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7ae35daa49866b302960062b23b1a9e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7ae35daa49866b302960062b23b1a9e0"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>LIMIT_RATE_MASK_AP</b>&#160;&#160;&#160;0x02</td></tr>
<tr class="separator:ga7ae35daa49866b302960062b23b1a9e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac24622a4d04f567ab5349699937be00c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac24622a4d04f567ab5349699937be00c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>LIMIT_RATE_MASK_ALL</b>&#160;&#160;&#160;0x03</td></tr>
<tr class="separator:gac24622a4d04f567ab5349699937be00c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga25f03eacfc5d1742ab1c365f9c9c29dd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga25f03eacfc5d1742ab1c365f9c9c29dd"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>FIXED_RATE</b> { <br />
&#160;&#160;<b>PHY_RATE_48</b> = 0x8, 
<b>PHY_RATE_24</b> = 0x9, 
<b>PHY_RATE_12</b> = 0xA, 
<b>PHY_RATE_6</b> = 0xB, 
<br />
&#160;&#160;<b>PHY_RATE_54</b> = 0xC, 
<b>PHY_RATE_36</b> = 0xD, 
<b>PHY_RATE_18</b> = 0xE, 
<b>PHY_RATE_9</b> = 0xF
<br />
 }<tr class="separator:ga25f03eacfc5d1742ab1c365f9c9c29dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
<tr class="memitem:ga97e6c6a565b563ee7f86b9468c971221"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga97e6c6a565b563ee7f86b9468c971221"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>support_rate</b> { <br />
&#160;&#160;<b>RATE_11B5M</b> = 0, 
<b>RATE_11B11M</b> = 1, 
<b>RATE_11B1M</b> = 2, 
<b>RATE_11B2M</b> = 3, 
<br />
&#160;&#160;<b>RATE_11G6M</b> = 4, 
<b>RATE_11G12M</b> = 5, 
<b>RATE_11G24M</b> = 6, 
<b>RATE_11G48M</b> = 7, 
<br />
&#160;&#160;<b>RATE_11G54M</b> = 8, 
<b>RATE_11G9M</b> = 9, 
<b>RATE_11G18M</b> = 10, 
<b>RATE_11G36M</b> = 11
<br />
 }<tr class="separator:ga97e6c6a565b563ee7f86b9468c971221"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
<tr class="memitem:gacb2eba65ea05876b28bfd1aa593ce44f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacb2eba65ea05876b28bfd1aa593ce44f"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>RATE_11B_ID</b> { <b>RATE_11B_B11M</b> = 0, 
<b>RATE_11B_B5M</b> = 1, 
<b>RATE_11B_B2M</b> = 2, 
<b>RATE_11B_B1M</b> = 3
 }<tr class="separator:gacb2eba65ea05876b28bfd1aa593ce44f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
<tr class="memitem:gafb85289f25a66fec6c117306fc764387"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafb85289f25a66fec6c117306fc764387"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>RATE_11G_ID</b> { <br />
&#160;&#160;<b>RATE_11G_G54M</b> = 0, 
<b>RATE_11G_G48M</b> = 1, 
<b>RATE_11G_G36M</b> = 2, 
<b>RATE_11G_G24M</b> = 3, 
<br />
&#160;&#160;<b>RATE_11G_G18M</b> = 4, 
<b>RATE_11G_G12M</b> = 5, 
<b>RATE_11G_G9M</b> = 6, 
<b>RATE_11G_G6M</b> = 7, 
<br />
&#160;&#160;<b>RATE_11G_B5M</b> = 8, 
<b>RATE_11G_B2M</b> = 9, 
<b>RATE_11G_B1M</b> = 10
<br />
 }<tr class="separator:gafb85289f25a66fec6c117306fc764387"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
<tr class="memitem:gace5af015da452fefa345f3ffc8b0f7d2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gace5af015da452fefa345f3ffc8b0f7d2"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>RATE_11N_ID</b> { <br />
&#160;&#160;<b>RATE_11N_MCS7S</b> = 0, 
<b>RATE_11N_MCS7</b> = 1, 
<b>RATE_11N_MCS6</b> = 2, 
<b>RATE_11N_MCS5</b> = 3, 
<br />
&#160;&#160;<b>RATE_11N_MCS4</b> = 4, 
<b>RATE_11N_MCS3</b> = 5, 
<b>RATE_11N_MCS2</b> = 6, 
<b>RATE_11N_MCS1</b> = 7, 
<br />
&#160;&#160;<b>RATE_11N_MCS0</b> = 8, 
<b>RATE_11N_B5M</b> = 9, 
<b>RATE_11N_B2M</b> = 10, 
<b>RATE_11N_B1M</b> = 11
<br />
 }<tr class="separator:gace5af015da452fefa345f3ffc8b0f7d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga23f9bd250fe2c037889cc061dbc8a15b"><td class="memItemLeft" align="right" valign="top">sint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__Rate__Control__APIs.html#ga23f9bd250fe2c037889cc061dbc8a15b">wifi_set_user_fixed_rate</a> (uint8 enable_mask, uint8 rate)</td></tr>
<tr class="memdesc:ga23f9bd250fe2c037889cc061dbc8a15b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the fixed rate and mask of sending data from ESP8266.  <a href="#ga23f9bd250fe2c037889cc061dbc8a15b">More...</a><br /></td></tr>
<tr class="separator:ga23f9bd250fe2c037889cc061dbc8a15b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0f8d0671a13fbfa34d30d56857018228"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__Rate__Control__APIs.html#ga0f8d0671a13fbfa34d30d56857018228">wifi_get_user_fixed_rate</a> (uint8 *enable_mask, uint8 *rate)</td></tr>
<tr class="memdesc:ga0f8d0671a13fbfa34d30d56857018228"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the fixed rate and mask of ESP8266.  <a href="#ga0f8d0671a13fbfa34d30d56857018228">More...</a><br /></td></tr>
<tr class="separator:ga0f8d0671a13fbfa34d30d56857018228"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafb6fea0b53f61743170baec0bd207b4f"><td class="memItemLeft" align="right" valign="top">sint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__Rate__Control__APIs.html#gafb6fea0b53f61743170baec0bd207b4f">wifi_set_user_sup_rate</a> (uint8 min, uint8 max)</td></tr>
<tr class="memdesc:gafb6fea0b53f61743170baec0bd207b4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the support rate of ESP8266.  <a href="#gafb6fea0b53f61743170baec0bd207b4f">More...</a><br /></td></tr>
<tr class="separator:gafb6fea0b53f61743170baec0bd207b4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0cb4293aeced3e3636b40f831dee54cc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__Rate__Control__APIs.html#ga0cb4293aeced3e3636b40f831dee54cc">wifi_set_user_rate_limit</a> (uint8 mode, uint8 ifidx, uint8 max, uint8 min)</td></tr>
<tr class="memdesc:ga0cb4293aeced3e3636b40f831dee54cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Limit the initial rate of sending data from ESP8266.  <a href="#ga0cb4293aeced3e3636b40f831dee54cc">More...</a><br /></td></tr>
<tr class="separator:ga0cb4293aeced3e3636b40f831dee54cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4c4b499ff0ebba2e74c3168f3e354052"><td class="memItemLeft" align="right" valign="top">uint8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__Rate__Control__APIs.html#ga4c4b499ff0ebba2e74c3168f3e354052">wifi_get_user_limit_rate_mask</a> (void)</td></tr>
<tr class="memdesc:ga4c4b499ff0ebba2e74c3168f3e354052"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the interfaces of ESP8266 whose rate of sending data is limited by wifi_set_user_rate_limit.  <a href="#ga4c4b499ff0ebba2e74c3168f3e354052">More...</a><br /></td></tr>
<tr class="separator:ga4c4b499ff0ebba2e74c3168f3e354052"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed1b4660c13be6154fd73c84a3ba96c2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__Rate__Control__APIs.html#gaed1b4660c13be6154fd73c84a3ba96c2">wifi_set_user_limit_rate_mask</a> (uint8 enable_mask)</td></tr>
<tr class="memdesc:gaed1b4660c13be6154fd73c84a3ba96c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the interfaces of ESP8266 whose rate of sending packets is limited by wifi_set_user_rate_limit.  <a href="#gaed1b4660c13be6154fd73c84a3ba96c2">More...</a><br /></td></tr>
<tr class="separator:gaed1b4660c13be6154fd73c84a3ba96c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>WiFi Rate Control APIs. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga0f8d0671a13fbfa34d30d56857018228"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int wifi_get_user_fixed_rate </td>
          <td>(</td>
          <td class="paramtype">uint8 *&#160;</td>
          <td class="paramname"><em>enable_mask</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8 *&#160;</td>
          <td class="paramname"><em>rate</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the fixed rate and mask of ESP8266. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">uint8</td><td>*enable_mask : pointer of the enable_mask </td></tr>
    <tr><td class="paramname">uint8</td><td>*rate : pointer of the fixed rate</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : succeed </dd>
<dd>
otherwise : fail </dd></dl>

</div>
</div>
<a class="anchor" id="ga4c4b499ff0ebba2e74c3168f3e354052"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8 wifi_get_user_limit_rate_mask </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the interfaces of ESP8266 whose rate of sending data is limited by wifi_set_user_rate_limit. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">null</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>LIMIT_RATE_MASK_NONE - disable the limitation on both ESP8266 station and soft-AP </dd>
<dd>
LIMIT_RATE_MASK_STA - enable the limitation on ESP8266 station </dd>
<dd>
LIMIT_RATE_MASK_AP - enable the limitation on ESP8266 soft-AP </dd>
<dd>
LIMIT_RATE_MASK_ALL - enable the limitation on both ESP8266 station and soft-AP </dd></dl>

</div>
</div>
<a class="anchor" id="ga23f9bd250fe2c037889cc061dbc8a15b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sint32 wifi_set_user_fixed_rate </td>
          <td>(</td>
          <td class="paramtype">uint8&#160;</td>
          <td class="paramname"><em>enable_mask</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8&#160;</td>
          <td class="paramname"><em>rate</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the fixed rate and mask of sending data from ESP8266. </p>
<dl class="section attention"><dt>Attention</dt><dd>1. Only if the corresponding bit in enable_mask is 1, ESP8266 station or soft-AP will send data in the fixed rate. </dd>
<dd>
2. If the enable_mask is 0, both ESP8266 station and soft-AP will not send data in the fixed rate. </dd>
<dd>
3. ESP8266 station and soft-AP share the same rate, they can not be set into the different rate.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">uint8</td><td>enable_mask : 0x00 - disable the fixed rate<ul>
<li>0x01 - use the fixed rate on ESP8266 station</li>
<li>0x02 - use the fixed rate on ESP8266 soft-AP</li>
<li>0x03 - use the fixed rate on ESP8266 station and soft-AP </li>
</ul>
</td></tr>
    <tr><td class="paramname">uint8</td><td>rate : value of the fixed rate</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : succeed </dd>
<dd>
otherwise : fail </dd></dl>

</div>
</div>
<a class="anchor" id="gaed1b4660c13be6154fd73c84a3ba96c2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool wifi_set_user_limit_rate_mask </td>
          <td>(</td>
          <td class="paramtype">uint8&#160;</td>
          <td class="paramname"><em>enable_mask</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the interfaces of ESP8266 whose rate of sending packets is limited by wifi_set_user_rate_limit. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">uint8</td><td>enable_mask :<ul>
<li>LIMIT_RATE_MASK_NONE - disable the limitation on both ESP8266 station and soft-AP</li>
<li>LIMIT_RATE_MASK_STA - enable the limitation on ESP8266 station</li>
<li>LIMIT_RATE_MASK_AP - enable the limitation on ESP8266 soft-AP</li>
<li>LIMIT_RATE_MASK_ALL - enable the limitation on both ESP8266 station and soft-AP</li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true : succeed </dd>
<dd>
false : fail </dd></dl>

</div>
</div>
<a class="anchor" id="ga0cb4293aeced3e3636b40f831dee54cc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool wifi_set_user_rate_limit </td>
          <td>(</td>
          <td class="paramtype">uint8&#160;</td>
          <td class="paramname"><em>mode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8&#160;</td>
          <td class="paramname"><em>ifidx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8&#160;</td>
          <td class="paramname"><em>max</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8&#160;</td>
          <td class="paramname"><em>min</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Limit the initial rate of sending data from ESP8266. </p>
<p>Example: wifi_set_user_rate_limit(RC_LIMIT_11G, 0, RATE_11G_G18M, RATE_11G_G6M);</p>
<dl class="section attention"><dt>Attention</dt><dd>The rate of retransmission is not limited by this API.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">uint8</td><td>mode : WiFi mode<ul>
<li>#define RC_LIMIT_11B 0</li>
<li>#define RC_LIMIT_11G 1</li>
<li>#define RC_LIMIT_11N 2 </li>
</ul>
</td></tr>
    <tr><td class="paramname">uint8</td><td>ifidx : interface of ESP8266<ul>
<li>0x00 - ESP8266 station</li>
<li>0x01 - ESP8266 soft-AP </li>
</ul>
</td></tr>
    <tr><td class="paramname">uint8</td><td>max : the maximum value of the rate, according to the enum rate corresponding to the first parameter mode. </td></tr>
    <tr><td class="paramname">uint8</td><td>min : the minimum value of the rate, according to the enum rate corresponding to the first parameter mode.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : succeed </dd>
<dd>
otherwise : fail </dd></dl>

</div>
</div>
<a class="anchor" id="gafb6fea0b53f61743170baec0bd207b4f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sint32 wifi_set_user_sup_rate </td>
          <td>(</td>
          <td class="paramtype">uint8&#160;</td>
          <td class="paramname"><em>min</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8&#160;</td>
          <td class="paramname"><em>max</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the support rate of ESP8266. </p>
<p>Set the rate range in the IE of support rate in ESP8266's beacon, probe req/resp and other packets. Tell other devices about the rate range supported by ESP8266 to limit the rate of sending packets from other devices. Example : wifi_set_user_sup_rate(RATE_11G6M, RATE_11G24M);</p>
<dl class="section attention"><dt>Attention</dt><dd>This API can only support 802.11g now, but it will support 802.11b in next version.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">uint8</td><td>min : the minimum value of the support rate, according to enum support_rate. </td></tr>
    <tr><td class="paramname">uint8</td><td>max : the maximum value of the support rate, according to enum support_rate.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : succeed </dd>
<dd>
otherwise : fail </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
